isisdataeval Updates, fixes and additional documentation #5163
Conversation
isisdata_mockup.py - Added —tojson and —hasher parameters to improve utility make_isisdata_mockup.sh - Fixed path to test data and added new parameters to the isisdata_mockup.py introduced in this PR README.md - improved/clarified/updated documentation
The CHANGELOG.md was incorrectly merged as the entry for this app was added in the wrong section, which seem wierd. This commit corrects and updates the log.
|
Question: Is it recommended/possible to install |
|
Any suggestions on where/how to install isisdata_mockup.py? This should be conveniently available to ISIS users if you decide to use this script as mechanism to validate ISISDATA installations. |
|
@KrisBecker at the end of the CMakeLists.txt, you can add a line to install it to $INSTALL_PREFIX/bin/ with the .py stripped so we can run it as a command. That's how we've usually done these utility scripts we want common accesss to. |
|
Ok, so should I scrub all the docs to refer to the renamed extension-less version of the script? At least in the READMEs and the tests scripts? |
isisdata_mockup.py - Install this script in $ISISROOT/bin as isisdata_mockup (no extension) make_isisdata_mockup.sh - Renamed isisdata_mockup.py to isisdata_mockup CMakeLists.txt - Add install command for isisdata_mockup
|
Commits install isisdata_mockup in $ISISROOT/bin (its not in I also changed the test data mocking script to call this version. This does create an issue for most of the documentation. It may be easier to just rename the script without the extension and change all the documentation appropriately otherwise I am concerned trying to retain the extension will lead to confusion. |
|
That would be helpful, yes. |
To ease use and minimize confusion, renamed isisdata_mockup.py to isisdata_mockup (w/o the .py extension) Updated documentation and install to reflect the change
|
Ok, renamed isisdata_mockup and modified docs/scripts to reflect the change. This PR should be good to go now. |
|
Please let me know if there is anything else I need to do in order to get this PR merged. Thank you. |
|
Once merge conflicts are resolved I'll merge this. |
…pdate # Conflicts: # CHANGELOG.md
This push resolves a merge conflict in the CHANGELOG.md Added a entry to CHANGELOG.md to describe the PR changes.
…Becker/ISIS3 into feature/isisdataeval-update
|
Merge conflict resolved in CHANGELOG.md and added an entry with these updates. |
|
There is a random error after the merge conflicts were fixed in the test. Might be a fluke so I am rerunning Jenkins for now. |
|
the error is still there, it did show up after the last commit. But it is a Spiceinit error trying to hit the web server. Might have been down at the time the test ran coincidentally. I'll run one more time, if it still fails on that test it will probably have to be debugged. |
Apologies I missed the merge of #5111 with a few, but perhaps helpful, updates.
isisdata_mockup.py - Added —tojson and —hasher parameters to improve utility
make_isisdata_mockup.sh - Fixed path to test data and added new parameters to the isisdata_mockup.py introduced in this PR
README.md - improved/clarified/updated documentation
Description
Related Issue
#5111
How Has This Been Validated?
Types of changes
Checklist:
Licensing
This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words: